chore: moved contents to the bottom of the README #2451
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
charleenfei
requested review from
colin-axner,
AdityaSripal,
crodriguezvega,
seantking,
damiannolan and
chatton
as code owners
colin-axner
approved these changes
Oct 3, 2022
There was a problem hiding this comment.
I'd be in favor of removing the contents section. I added it initially, but I feel like our repo is decently self explanatory once you click on "modules". It might be better to just add a doc into each directory explaining what the directory contains. Then the readme could just point to maybe "modules" "e2e" and "docs" as being the most relevant
i'll break this out into a issue so we can track these suggestions :) |
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
currently, the contents are the first thing you see when you go to the repo. However, the average person going to our repo is probably less likely wanting to immediately start navigating through the codebase, and more likely to want to find out things like: our roadmap, releases/version matric, how to contribute, how to report a bug, how to contact the community.
this is just an UX change, i haven't actually touched the content section itself, just moved it to the bottom.
Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.
docs/) or specification (x/<module>/spec/)godoccomments.Unreleasedsection inCHANGELOG.mdFiles changedin the Github PR explorerCodecov Reportin the comment section below once CI passes